home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / ascii / figlet / !Figlet / Docs / README_unx < prev    next >
Text File  |  1995-12-10  |  6KB  |  147 lines
  1. About figlet (Frank, Ian & Glenn's Letters) release 2.0, August 9, 1993
  2. ----------------------------------------------------------------------
  3.  
  4. figlet is a program that creates large characters out of ordinary
  5. screen characters.  figlet can create characters in many different
  6. styles and can "smush" these characters together in various ways.
  7. figlet output is generally reminiscent of the sort of "signatures" many
  8. people like to put at the end of e-mail and UseNet messages.  Some
  9. example figlet output is given below.
  10.  
  11. If you like figlet (hey, even if you _hate_ figlet), please send an
  12. e-mail message to spectre@uiuc.edu or figlet@uiuc.edu.
  13.  
  14. [Note: Apple IIGS GNO users having no "C" compiler can contact Jawaid
  15. Bazyar at <bazyar@csn.org> for a pre-compiled GNO version of figlet.]
  16.  
  17.  
  18. Files
  19. -----
  20.  
  21. README    -- This file.
  22. figlet.c  -- The figlet source code.
  23. Makefile  -- The figlet makefile.  Used by the make command.
  24. figlet.6  -- The figlet man(ual) page.
  25. <xxx>.flf -- All files ending in ".flf" are figlet font files.
  26.  
  27.  
  28. Installing figlet
  29. -----------------
  30.  
  31. First decide in which directories figlet, and the figlet font files
  32. (the ".flf" files) will be stored (usually "/usr/games" and
  33. "/usr/games/lib/figlet.dir") and which will be the default font (we
  34. recommend "standard.flf").
  35.  
  36. Edit "Makefile", and set the variables DEFAULTFONTDIR, DEFAULTFONTFILE
  37. and OLD_DIR_STRUCTS to the appropriate values.  Set DEFAULTFONTDIR to
  38. be the full pathname of the directory in which you will keep the figlet
  39. font files.  Set DEFAULTFONTFILE to be the filename of the default
  40. font.  OLD_DIR_STRUCTS should normally be 0.
  41.  
  42. Then, in the directory with the figlet source in it, type "make
  43. install".
  44.  
  45. If the program fails to compile, set OLD_DIR_STRUCTS to 1 in Makefile,
  46. and type "make install" again.  (Setting OLD_DIR_STRUCTS to 1 makes
  47. figlet use an older method of reading directories.  On newer systems,
  48. this method will often compile without errors, but will not run
  49. properly, so OLD_DIR_STRUCTS should only be set to 1 if figlet will not
  50. compile otherwise.)
  51.  
  52. If you cannot, or do not want to install the man pages, you can still
  53. probably read it using
  54.     nroff -man figlet.6 | more
  55. and you should not use "make install" but just "make" and then copy the
  56. files manually.
  57.  
  58. If space is a problem, the only files you absolutely must have to run
  59. figlet are "figlet" (the executable) and at least one font (preferably
  60. the one you chose to be the default font).
  61.  
  62. We have successfully compliled figlet on the following systems:
  63.  
  64. Hardware              Operating System
  65.  
  66. Sun SPARC             SunOS V4.1.3
  67. SGI Iris 4D/25GT      IRIX V4.0.5
  68. SGI Iris 4D/340VGX    IRIX V4.0.5
  69. SGI Iris Skywriter    IRIX V4.0.5
  70. Cray 2                UNICOS V6.1
  71. Cray Y-MP             UNICOS V6.1
  72. Sequent S81           DYNIX V3.1.1
  73. Convex C240           ConvexOS V10.1
  74. IBM RS/6000           AIX V3
  75. HP 9000/375           HP-UX V7.0
  76. NeXT Mach             NeXTstep V3.0
  77.  
  78.  
  79. Using figlet
  80. ------------
  81.  
  82. At the shell prompt, type "figlet".  Then type, say, "Hello, world!"
  83. and press return.  "Hello, world!" in nice, big, designer characters
  84. should appear on your screen.  If you chose standard.flf to be the
  85. default font, you should see
  86.  _   _      _ _                             _     _ _ 
  87. | | | | ___| | | ___    __      _____  _ __| | __| | |
  88. | |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` | |
  89. |  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |_|
  90. |_| |_|\___|_|_|\___( )   \_/\_/ \___/|_|  |_|\__,_(_)
  91.                     |/                                
  92. (By the way, the above is meant to be diplayed in a monospaced font.)
  93. Then type something else, or type an EOF (typically control-D) to quit
  94. figlet.
  95.  
  96. Now you can send the output of figlet to a file (e.g., "figlet > file")
  97. and e-mail it to your friends (who will probably say, "Wow!  It must
  98. have taken you hours to put that together!")
  99.  
  100. To use other fonts, use the "-f" command line option.  For example, if
  101. you had said "figlet -f smslant" above, you would have seen
  102.    __  __    ____                         __   ____
  103.   / /_/ /__ / / /__      _    _____  ____/ /__/ / /
  104.  / __  / -_) / / _ \_   | |/|/ / _ \/ __/ / _  /_/ 
  105. /_/ /_/\__/_/_/\___( )  |__,__/\___/_/ /_/\_,_(_)  
  106.                    |/                              
  107.  
  108. Here are some other useful command line options:
  109.  
  110. -c  center -- centers the output of figlet.
  111. -t  terminal -- figlet asks your terminal how wide it is, and uses
  112.     this to determine when to break lines.  Normally, figlet assumes
  113.     80 columns so that people with wide terminals won't annoy the
  114.     people they e-mail figlet output to.
  115. -D  Deutsch -- switches to the German character set.  Turns `[', `\'
  116.     and `]' to umlauted A, O and U, respectively.  `{', `|' and `}'
  117.     turn into the respective lower case versions of these.  `~' turns
  118.     into s-z.
  119. -p  paragraph mode -- eliminates some spurious line breaks when piping
  120.     a multi-line file through figlet.
  121. -F  Fonts -- lists the available figlet fonts.
  122. -v  version -- prints information about your copy of figlet.
  123.  
  124. For in-depth explanations of these and other otions, see the man page.
  125.  
  126.  
  127. Other Stuff
  128. -----------
  129.  
  130. Although you don't have to design your own fonts to use figlet, we'd
  131. certainly like it if lots of people did make up new figlet fonts.  If
  132. you feel like giving it a try, see the "FONT FILE FORMAT" section of
  133. the man page.
  134.  
  135. See "Other Things to Try" in the EXAMPLES section of the man page
  136. for...  well... other things to try.
  137.  
  138.  
  139. Authors
  140. -------
  141.  
  142. figlet was written mostly by Glenn Chappell <ggc@uiuc.edu>.  The
  143. author not being an e-mail fanatic, most correspondence (bug reports,
  144. rave reviews, etc.) should be directed to his secretary (who is
  145. definitely an e-mail fanatic), Ian Chai <spectre@uiuc.edu> (or
  146. figlet@uiuc.edu).
  147.